Xbasic

FILE.STREAM_TO_STRING Function

Syntax

String as C = FILE.Stream_To_String(P stream_from,P control[,N chunksize[,N max_length]])

Arguments

stream_fromPointer

A file pointer or socket pointer.

controlPointer

A pointer with two elements:

bytesNumeric

A running count of how many bytes have been streamed so far. It does not matter what you set this to, it gets reset to 0 at the beginning of the stream operation and it automatically updated as the stream progresses. This can be used to implement a progress bar.

exitLogical

A logical flag. If it is set to .t., the stream operation will abort. This can be used to implement a cancel button

chunksizeNumeric

Indicates the size of the chunks transferred from the stream.

max_lengthNumeric

Indicates the maximum bytes that should be read. The operation will stop if it reaches this size, even if there is more data available.

Returns

StringCharacter

The resulting character data.

Description

Perform a streamed copy to a string- control variables include .exit and .bytes .

Discussion

Streaming is a faster, optimized way of copying. The FILE.STREAM_TO_STRING() method copies data from a file or socket to a character variable.

See Also